Бриф
Бриф на доработку сайта n2o.dev. Описываемый проект не имеет своей целью извлечение прибыли, сразу договоримся о возможных терминах:
Клиент = Пользователь = Почитатель = Адепт = Приверженнец
Товар = Продукт = Услуга = Репозиторий
Каталог = Список репозиториев
Покупка = Продажа = Сбыт = Пользование
1. Общая информация о компании
1.1. Полное и сокращённое название компании
"Synrc Research Center" (англ.) или "Научно-исследовательський центр SYNRC" (рус.), в сокращённой форме — просто SYNRC или Synrc.
1.2. Основная сфера деятельности
Архитектурная Компания SYNRC занимается разработкой и созданием комплексных решений в области автоматизированных систем управления большими предприятиями. Основные сервисы компании — разработка архитектуры предприятия, модулей или компонентов предприятия, тренинги персонала, авторский надзор при внедрении, поддежка всех нижележащих библиотек, на которых построена система — главный продукт компании — erp.uno.
1.3. Название сайта и адреса
Сайт n2o.dev или DEV является документацией по нижележащим библиотекам: веб-фреймворк, базы-данных, управления бизнес-процесами, центр сертификации X.509, RPC библиотеки и другие низкоуровневые сервисы. Сайт является витриной Github организации github.com/synrc.
1.3. Позиционирование на рынке
Компания занимается разработкой сервисов повышенной надежности и емкости на платформах Erlang и Elixir для клиентов, занимающихся информационными и/или телекомуникационными технологиями: правительственные организации, банки, мобильные операторы, высоконагруженные онлайн сервисы, сервисы доставки сообщений и т.д. Мы рабтаем в соответствии с архитектурными стандратами ISO-42010.
Миссия компании принести простоту и ясность в разработку сложных систем. Наша главная задача обнажить сложность и оставить только необходимый минимум, поэтому наши библиотеки отличаются минималистичностью, которая достигается за счет оптимизации по единственному параметру — количество строк кода библиотеки.
Второй уникальный критерий наших нижележащих библиотек n2o.dev — это портируемость на все существующие языки программирования. Поэтому мы начали серию портов на самые формальные языки: Agda, Lean, Standard ML, Haskell. В промышленном состояниии находится поддержка следующих языков: Erlang, Elixir. Языки третьего эшелона на которые возможно портирование этих библиотек: Java, C#, Clojure, F#, Scala, Rust. Список текущего состояния портов можно посмотреть на сайте n2o.tech.
1.4. Контактная и дополнительная информация
Генеральный директор компании — Андрей Задорожний, главный архитектор компании — Максим Сохацкий [email protected] +380676631870. Компания функционирует с 2005 года.
1.5. Сроки
Мы собираемся давать рекламу по нашим субпродуктам (модулям предприятия) erp.uno, к 15-летию компании, в 2020 году. Поэтому, сайт для нижележаших библиотек n2o.dev, к этому времени, необходимо довести до запредельного качества.
2. Информация о проекте n2o.dev
2.1. Полное и сокращённое название проекта
Кодовое называние проекта перетерпело много изменений, в текущей стадии я остановился на кодовом названии DEV (от devas, небожители, или developers — разработчики). Доменное имя n2o.dev защищено до 2029 года.
2.2. Тип сайта
Тип сайта совершенно стандартный — это формальная документация для программистов. Аналоги в других мирах — это официальная документация компаний по своим продуктам (MSDN, MDN, ADN, и т.д.), которая предназначена для ежедневного использования программистами, поэтом количество рекламы или ненужной информации на сайте должно равнятся абсолютному нулю, а не как у других.
Каждая станица сайта автоматически конвертируется в ROFF документа (UNIX man страницы), оргиналы документов находятся в XHTML формате. Да да, некоторые программисты не любят заходить в браузер, и используют исключеться терминалы в ежедневном производственном процессе. Именно для них мы сделали поддержку генерации ROFF man страниц.
Все, кто занимаются сайтами данного типа называются операторы документации (DocOps), так как помимо дизайна, документационного копирайтинга, текникал врайтинга, этот сайт подразумевает создание инструментария для генерации шаблонных документов из исходников, генерация документов других форматов (например pandoc), патча хедеров, статических генераторов и трансформаторов.
2.3. Цели и задачи
Главная цель — это сделать жизнь разработчика максимально комфортной, потому что он должен проводить каждый рабочий день с документацией. Важно, чтобы: 1) документация легко читалась, 2) была легковесной и конкретной, 3) отвечала на все вопросы, 4) соответсвовала общей концепции минимализма, которая положена в основу всех наших продуктов, 5) покрывала каждый исходник и модуль, 6) поддерживала несколько цветовых гамм для всех типов личностей (минимум две), 7) доступ к любому модулю предоставлялся за 1 клик, и т.д. Это все составляют прямые цели и задачи.
Кроме прямых целей, улучшение документанции разработчика также предполагает косвенные цели, которые преследуются процессом улучшения сайта: 1) Выход на новые рынки (страны) и соотвественно языки, создание переводов. На данных моменит в той или иной степени поддерживаются следующие языки: Английский (по-умолчанию), Украинский (родной язык автора), Русский (язык максимального числа программистов работающих с библиотеками), Немецкий, Болгарский, Иврит; 2) Формирование сообщества: наличие интернациональной документации является залогом здорового коммюнити разработчиков. 3) Улучшение и формализация процесса документирования: при четко поставленном DocOps процессе вероятность вовлечения самих разработчиков в процесс документирования увеличивается, так как программисты возможно захотят сами реформулировать некоторые положение, описанные в документации.
2.4. Критерии успешности
Документация
2.5. Существующие проблемы
2.6. Создание впечатления
2.7. Дополнительная информация
3. Информация о товарах и услугах n2o.dev
3.1. География реализации
Основные потребители библиотек находятся в следующих странах: Украина, Беларусь, Россия, Швейцария, Германия, Франция, США, Канада, Китай.
3.2. Конкуретные преимущества
3.3. Форма реализации
3.4. Продукты хедлайнеры
3.5. Частота выпуска новых версий
3.6. Основные кокуренты
3.7. Сильные и слабые стороны конкурентов
3.8. Рекламная поддержка
3.9. Участие сайта в продажах
3.10. Количество товаров и услуг
3.11. Исполнители и текущее состояние товаров и услуг
4. Структура сайта
3.1. География реализации
3.2. Конкуретные преимущества
3.3. Форма реализации